/*
 * Copyright (c) 2024 endless-sky
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _HAL_JPEG_H_
#define _HAL_JPEG_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "hal_struct.h"

/*
 * JPEG 抓拍/编码接口
 *
 * 能力：
 * - 从 YUV 帧（VPSS/VI 输出）硬件编码为 JPEG 数据
 * - 支持设置 JPEG 质量（1-100），0 表示使用默认质量
 * - 可选 ROI 裁剪（按硬件对齐，越界自动裁剪）
 */

/**
 * @brief 从 YUV 帧编码为 JPEG，一次性返回完整 JPEG 数据。
 *
 * @param[in]  pYuvFrame  输入的 YUV 帧（由 Hal_Yuv_GetFrame 获取，需包含底层句柄 pRelHandler）
 * @param[in]  u32Quality JPEG 质量 [1-100]，0 表示使用默认质量（推荐 50）
 * @param[in]  pCrop      可选裁剪区域，NULL 则编码整帧；接口内部按硬件要求进行边界与对齐处理
 * @param[out] pJpegOut   输出 JPEG 数据，函数内部分配内存并填充；调用者需在使用后调用 Hal_Jpeg_Release 释放
 *
 * @return HAL_SUCCESS 成功；其他值失败
 */
int32_t Hal_Jpeg_Encode(const HAL_YUV_FRAME_S *pYuvFrame,
                        uint32_t u32Quality,
                        const HAL_BASE_RECT_S *pCrop,
                        HAL_IMAGE_DATA_S *pJpegOut);

/**
 * @brief 释放 Hal_Jpeg_Encode 产生的 JPEG 输出缓冲
 *
 * @param[in,out] pJpegOut HAL_IMAGE_DATA_S 指针，内部 pData 不为 NULL 时释放并置空
 */
void Hal_Jpeg_Release(HAL_IMAGE_DATA_S *pJpegOut);

#ifdef __cplusplus
}
#endif

#endif // _HAL_JPEG_H_
